Skip to content

Conversation

rrbutani
Copy link
Contributor

@rrbutani rrbutani commented Jul 22, 2025

In #345 we used a couple of features that I didn't realize aren't supported by mdbook by default (but are part of GitHub flavored markdown): mermaid and alerts.

This PR:

  • updates mdbook to pick up changes to how footnotes are rendered (grouped at the bottom of the page w/backrefs rather than inline)
  • swaps >[!NOTE] (GFM alert) for mdbook's ~equivalent
  • adds mdbook-mermaid to render mermaid diagrams — if this is undesirable I can update relink-dont-rebuild.md to use pre-rendered images for the diagrams

Rendered

rrbutani added 3 commits July 22, 2025 11:45
([`mdbook-alerts`](https://github.com/lambdalisue/rs-mdbook-alerts)
exists but since we've only got the one usage...)
note: running `mdbook-mermaid install` before building the book rather
than vendoring `mermaid.min.js`/`mermaid-init.js` into the repo
@nikomatsakis nikomatsakis merged commit 3ae4a29 into rust-lang:main Jul 31, 2025
2 checks passed
@rrbutani rrbutani deleted the fix/rdr-fmt branch July 31, 2025 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants